/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.framework.localization.xml;

import axil.framework.localization.TranslationValue;
import axil.framework.xml.InputXML;
import axil.framework.xml.XML;
import axil.stdlib.collection.type.Range;

import java.util.List;


/**
 * The XML definition of elements within a resource file.
 */
@XML(types = {TemplateResource.class, TextResource.class})
public abstract class ResourceElement {
	private String key;
	private String content;
	private List<ResourceVariant> variants;


	protected ResourceElement(InputXML xml) {
		key = xml.text("key");
		content = xml.content("content", null);
		variants = xml.variants(ResourceVariant.class, Range.any);
	}

	public String key()			{
		return key;
	}
	protected String content()	{
		return content;
	}
	protected boolean variant()	{
		return ! variants.isEmpty();
	}
	protected List<ResourceVariant> variants() {
		return variants;
	}


	/**
	 * Construct a translation value appropriate to the contents contained in
	 * this object.
	 */
	public abstract TranslationValue construct();
}
